package org.dromara.starter.jpacomment.annotation;

import org.dromara.starter.jpacomment.enums.IndexType;
import org.dromara.starter.jpacomment.enums.Nullable;

import java.lang.annotation.*;

/**
 * SAIL @SailColumn场景适用于更新字段
 *      @Column适合添加字段
 * @author <a href="mailto:guzhongtao@middol.com">guzhongtao</a>
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface SailColumn {

    /**
     * 字段注释
     *
     * @return String
     */
    String comment() default "";

    /**
     * 字段类型
     *
     * @return String
     */
    String type();

    /**
     * 字段默认值
     *
     * @return String
     */
    String defaultValue() default "NULL";


    /**
     * 字段是否允许为空
     *
     * @return String
     */
    Nullable nullable() default Nullable.NULL;
}
